#ifndef OMG_DDS_SUBSCRIBER_HPP_
#define OMG_DDS_SUBSCRIBER_HPP_

/* Copyright (c) 2009-2010, Real-Time Innovations, Inc.
 * Copyright (c) 2010, Object Management Group, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the names of the above copyright holders nor the names of their
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL A COPYRIGHT HOLDER OR CONTRIBUTOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


template <typename DELEGATE>
class tdds::sub::CoherentAccess
{
public:
    /**
     * This operation indicates that the application is about to access
     * the data samples in any of the DataReader objects attached to the
     * Subscriber.  The application is required to use this operation
     * only if PRESENTATION QosPolicy of the Subscriber to which the
     * DataReader belongs has the access_scope set to ‘GROUP.’ In the
     * aforementioned case, the operation begin_access must be called
     * prior to calling any of the sample-accessing operations, namely:
     * get_datareaders on the Subscriber and read, take,
     * read_w_condition, take_w_condition on any DataReader. Otherwise
     * the sample-accessing operations will return the error
     * PRECONDITION_NOT_MET. Once the application has finished accessing
     * the data samples it must call end_access.  It is not required for
     * the application to call begin_access/end_access if the
     * PRESENTATION QosPolicy has the access_scope set to something
     * other than ‘GROUP.’ Calling begin_access/end_access in this case
     * is not considered an error and has no effect.  The calls to
     * begin_access/end_access may be nested. In that case, the
     * application must call end_access as many times as it called
     * begin_access.
     */
    explicit CoherentAccess(dds::sub::Subscriber& sub);
    CoherentAccess(const CoherentAccess& src);

public:
    ~CoherentAccess();  // ends access implicitly

public:
    /**
     * This operation indicates that the application is about to access
     * the data samples in any of the DataReader objects attached to the
     * Subscriber.  The application is required to use this operation
     * only if PRESENTATION QosPolicy of the Subscriber to which the
     * DataReader belongs has the access_scope set to ‘GROUP.’ In the
     * aforementioned case, the operation begin_access must be called
     * prior to calling any of the sample-accessing operations, namely:
     * get_datareaders on the Subscriber and read, take,
     * read_w_condition, take_w_condition on any DataReader. Otherwise
     * the sample-accessing operations will return the error
     * PRECONDITION_NOT_MET. Once the application has finished accessing
     * the data samples it must call end_access.  It is not required for
     * the application to call begin_access/end_access if the
     * PRESENTATION QosPolicy has the access_scope set to something
     * other than ‘GROUP.’ Calling begin_access/end_access in this case
     * is not considered an error and has no effect.  The calls to
     * begin_access/end_access may be nested. In that case, the
     * application must call end_access as many times as it called
     * begin_access.
     */
    void end();         // ends access explicitly

    // --- State: --- //
private:
    friend class OMG_DDS_COHERENT_ACCESS_DELEGATE;
    DELEGATE impl_;
};


#endif // !defined(OMG_DDS_SUBSCRIBER_HPP_)
